home *** CD-ROM | disk | FTP | other *** search
/ Aminet 19 / Aminet 19 (1997)(GTI - Schatztruhe)[!][Jun 1997].iso / Aminet / comm / xeno / bsytme112.lha / BusyTime.doc < prev    next >
Text File  |  1997-04-03  |  17KB  |  397 lines
  1. 03-Apr-97
  2.                              Doc for BusyTime V1.12
  3.                             ~~~~~~~~~~~~~~~~~~~~~~~~
  4.  
  5.  
  6. COPYRIGHT:
  7. ~~~~~~~~~~
  8. This program is XenoWare. If you own Xenolink Pro BBS you may use it
  9. freely and spread it to other users of Xenolink, as long as the archive
  10. remains in it's original state! Another requirement for using it more
  11. than two weeks is that you send me a netmail telling me you're using it!
  12.  
  13.  
  14. CHANGES V1.11 -> V1.12 (Released 03-Apr-97):
  15. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16. * Made the scanning before finding lastline much faster! Ie. if information
  17.   about a lastline is found, the programme will skip everything until this
  18.   lastline is found in the datafile.
  19.  
  20.  
  21. CHANGES V1.10 -> V1.11 (Released 06-Jan-97):
  22. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23. * Something strange happened after newyear! The busyweek information would be
  24.   out of sync! Data that should have been registrated under wednesday for
  25.   example, would instead be entered under tuesday. I finally found that it was
  26.   because last year, 1996, was what we in Sweden call "skottår", ie there's 29
  27.   days in February. When going from 96 to 97 a flag that was set wasn't reset to
  28.   zero and that's why it didn't calculate the day of the week correctly.
  29. * Since no one ever sends me any netmails or emails telling me they use my
  30.   programme, it's either that no one uses it (which makes it more or less
  31.   unnescessary to release new updates), or it's because no one bothers with it!
  32.   Therefor I've implemented a keyfile for using my programme after a specific
  33.   date. The registration is TOTALLY FREE except for an email with your name and
  34.   request for registration. Send it to the address stated below.
  35. * Found some code that didn't do anything and removed it.
  36.  
  37.  
  38. CHANGES V1.9 -> V1.10 (Released 961011):
  39. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  40. * The programme now saves data that 'rolls out' from the BusyTime<n>.log to a
  41.   file called BusyTime<n>.Old.log. So, if the normal file is full and a new day
  42.   is added at the end, the first day in the log is added to the .Old file
  43.   instead of being lost in the binary space! This new log keeps upto 925 days,
  44.   so in all you can have a log of 1000 days!
  45. * Wrote a small extra tool for Busytime called "BusyTimeAll". This programme is
  46.   only for giving Sysop information over a longer time than the normal 75 days.
  47.   It reads the .Old log, and then the normal log and uses the data to create a
  48.   textfile in RAM: called "BusyTimeAll.txt". This is exactly the same as the
  49.   Busy<n>.txt, ie a view over the busytime of the day, but this one shows ALL
  50.   DAYS in both .Old and normal file... In the end you will have a nice view over
  51.   the busytime over 1000 days!!!
  52.  
  53.   Usage: BusyTimeAll [node]
  54.  
  55.   By default, the data for node 1 is used.
  56. * Fixed a stupid bug where the OutputPath was being used as the defaultcolour!
  57.   Man, did the output look stupid! ;-) Sorry about that!!!
  58.  
  59.  
  60. CHANGES V1.8 -> V1.9 (Released 960926):
  61. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62. * Had some complaints about the programme being hardcoded to produce the
  63.   textfiles in the BBS:Text/ drawer. The programme is now fully configurable on
  64.   this point. Add a line in the file XConfig:BusyTime/BusyTime.cfg before the
  65.   first one, ie the new line must be the first in the config. On this line you
  66.   state where you want the output to be located. This path is refered to as the
  67.   "OutputPath" in the rest of this document!
  68. * No bugfix, nothing really, just a tip! If you want to create two sets of
  69.   files, one with and one without colour for example, you could do like this:
  70.  
  71.   Create two sets of XConfig:BusyTime/BusyTime.cfg and call them BusyTime.cfg1
  72.   and BusyTime.cfg2. In the first you have the coloursettings, and in the second
  73.   you instead enter the colourcode  or perhaps nothing at all.
  74.   Then create a script that does something like this:
  75.   
  76.   Copy XConfig:BusyTime/BusyTime.cfg1 XConfig:BusyTime/BusyTime.cfg
  77.   BusyTime ALL
  78.   Move OutputPath:Busy1.txt ColourPath:Busy1.txt
  79.   Move OutputPath:Upload1.txt ColourPath:Upload1.txt
  80.   Move OutputPath:Download1.txt ColourPath:Download1.txt
  81.   Move OutputPath:BusyHour1.txt ColourPath:BusyHour1.txt
  82.   Move OutputPath:Busyweek1.txt ColourPath:Busyweek1.txt
  83.   Copy XConfig:BusyTime/BusyTime.cfg2 XConfig:BusyTime/BusyTime.cfg
  84.   BusyTime ALL NOSCAN
  85.  
  86.   Now you will have two sets of textfiles, one with and one without colour!
  87.   Of course, you don't have to move the file, a simple renaming of the files
  88.   would probably also do the trick!
  89.  
  90.  
  91. CHANGES V1.7 -> V1.8 (Released 960911):
  92. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  93. * Sometimes for some reason, some of the data would be set to a negative
  94.   number. The bug is still there, but now it's not saved atleast.
  95.  
  96.  
  97. CHANGES V1.6 -> V1.7 (Released 960225):
  98. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99. * Fixed a bug with "unsuccessful recieve".
  100. * Fixed a bug with "Incomplete file".
  101. * Speeded up reading of the logfile! No copying to RAM: nomore! The
  102.   programme now uses about 1MB of memory to accept a logfile of that
  103.   size. If the log is larger than this the programme may not work!
  104. * Speeded up the creation of all files!
  105. * Added support for re-logins.
  106. * Added stats on a weekly basis. Works exactly like the other bulletins.
  107.   Keyword = BSYWEEK.
  108.  
  109.  
  110. CHANGES V1.5 -> V1.6 (Released 960204):
  111. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  112. * Due to a counting error, the bottom part of the charts was too short.
  113. * Bars showing more than 50% in BUSY and BSYHOUR will be coloured red.
  114. * If run during an ongoing call, the lastline information saved will be
  115.   that of the previous call.
  116. * Added SCREEN keyword for presentation in a shellwindow.
  117. * Added Busytime.env possibility.
  118. * Moved logfiles and datafiles to XConfig:Busytime/Data/. If using older
  119.   version of Busytime, please create this path and move the files used
  120.   by Busytime in XLog: there.
  121. * Fixed a severe bug when running the programme for the first time. No
  122.   lastline information was saved, resulting in a re-read of old data
  123.   when run a second time.
  124.  
  125.  
  126. CHANGES V1.4 -> V1.5 (Released 960114):
  127. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  128. * I installed AFS on my Xenolink partition. I found that though AFS
  129.   speeded up most thing conserning diskhandling, it severly slowed down
  130.   the creation of files with Busytime! So I rewrote it to create the
  131.   files in RAM: first and then copy the result to disk rather than
  132.   creating them directly on disk.
  133.  
  134.  
  135. CHANGES V1.3 -> V1.4 (Released 960112):
  136. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  137. * Bug: Programme would save it's datafiles even if no new call was found.
  138. * Bug: Due to a division by zero, the programme would sometimes fail to
  139.   create the totalstats file.
  140. * Added ALL argument which causes all charts to be created with one
  141.   command.
  142. * Added NOSCAN argument, causing programme to not scan for new entries.
  143. * Added statistics for every hour. Keyword is BSYHOUR.
  144. * Cleaned up output to screen.
  145. * Moved header text to center of screen.
  146.  
  147.  
  148. CHANGES V1.2 -> V1.3 (Released 960103):
  149. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  150. * Big rewrite, changing configfile and way of running programme.
  151. * Added: Stats for uploads and downloads.
  152. * You now choose which stats to create, running with no args will only
  153.   update datafile.
  154.  
  155.  
  156. CHANGES V1.1 -> V1.2 (Released 951213):
  157. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  158. * BusyTime now copies the logfile to ram: before scanning it.
  159. * Buggfix: If no new calls were found, it would still show it found 1 call.
  160. * Buggfix: programme would redraw uploaded files even if there were no
  161.   bytes uploaded, ie. transfer aborted before it had even begun.
  162.  
  163.  
  164. CHANGES V1.0 -> V1.1 (Released 951122):
  165. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  166. * Rewrote it so it no longer has to shut down the logserver. Instead it
  167.   saves the last line to a file in XLOG:.
  168.   To make the programme NOT scan from the beginning (new lastline
  169.   recognition, remember) find the last answering line before the last
  170.   busytime logline in the call-x.log file and copy this line to the
  171.   lastline-file for that node. Did you REALLY get that? :) Or why not
  172.   erase the datafile for that node alltogether, and restart the damned
  173.   thing! :) Well, an answerline could look something like this:
  174.   
  175.   * 21-Nov-95 23:31:18 Answering modem
  176.   
  177.   Look for the last of those, that comes before the last one of these:
  178.   
  179.   | 11-14-1995 15:50:02 BusyTime
  180.  
  181. * Found a bug that counted unsuccessful uploads. I'm using UPFid, so
  182.   this may not work if you're not (using UPFid that is!). If a line
  183.   that looks like this:
  184.   
  185.   Zmodem receive unsuccessful
  186.   
  187.   is found, the last read uploaded bytes will not count. (hmmm, I think
  188.   I'll stop writing these docs! Drives me insane!)
  189.  
  190. * Added visual information about the progress of the logscan.
  191.  
  192.  
  193. V1.0 Released 951114
  194. ~~~~~~~~~~~~~~~~~~~~
  195.  
  196. WHAT IS IT:
  197. ~~~~~~~~~~~
  198. A programme to create...       * a file with statistics about what's
  199.                                  in the Call-x.log for sysop's pleasure.
  200.                                * a textfile to show the users the
  201.                                  upload statistics during last 75 days.
  202.                                * a textfile to show the users the
  203.                                  download statistics during last 75 days.
  204.                                * a textfile to show the users how
  205.                                  busy the BBS has been the last 75 days.
  206.                                * a textfile to show the users how busy
  207.                                  the BBS is every hour.
  208.                                * a textfile to show the users how busy
  209.                                  the BBS is every day of the week.
  210.  
  211.  
  212. INSTALLATION:
  213. ~~~~~~~~~~~~~
  214. I HATE writing these docs!
  215.  
  216. * Copy the BusyTime drawer with its content to Xconfig:
  217. * The programme will create five textfiles to show for the users called:
  218.  
  219.   OutputPath:Busy<n>.txt
  220.   OutputPath:Upload<n>.txt
  221.   OutputPath:Download<n>.txt
  222.   OutputPath:BusyHour<n>.txt
  223.   OutputPath:Busyweek<n>.txt
  224.  
  225.   where <n> is the nodenumber. Therefor, edit your bulletinmenu.src and add
  226.   the files on this format:
  227.   
  228.   CMD = "Your_Command"
  229.     {
  230.       TypeFile "Busy1.txt"
  231.     }
  232.  
  233. * Edit the configfiles:
  234.   TotalTemplate<n>: <n>=nodenumber
  235.     This file is the template for the totalstats file that will be
  236.     created in RAM: and you can edit it as you like. There are some
  237.     autoinserts you can use:
  238.  
  239.     %DATE - The date the following data was collected               [9]
  240.     %C    - Calls to BBS                                            [3]
  241.     %FC   - Fidonet calls to BBS                                    [3]
  242.     %U    - Uploaded files                                          [3]
  243.     %UB   - Uploaded bytes                                         [11]
  244.     %D    - Downloaded files                                        [3]
  245.     %DB   - Downloaded bytes                                       [11]
  246.     %FS   - Files send in fidonet session                           [3]
  247.     %FSB  - Bytes send in fidonet session                          [11]
  248.     %FR   - Files recieved in fidonet session                       [3]
  249.     %FRB  - Bytes recieved in fidonet session                      [11]
  250.     %UCPS - Average CPS while uploading (and recieving in fidonet)  [4]
  251.     %DCPS - Average CPS while downloading (and sending in fidonet)  [4]
  252.     %BT   - Busytime of BBS in HH:MM:SS                             [8]
  253.     %P    - Busytime of BBS in percent                              [2]
  254.     
  255.     The inserts will allways use the same space, wich is shown in
  256.     brackets above. For more information, please have a look at the
  257.     sample template. Remember to allways use capital letters!
  258.     
  259.   BusyTime.cfg
  260.     This file contains information about the textfile to create for the
  261.     users. There's one piece of data on each line and are as follows:
  262.  
  263.     Line     Type of data     Example          Note
  264.     ----     ------------     ------------     -----------------------------
  265.        1     OutputPath       Xenolink:Text/   Where the files should be located
  266.        2     DefaultColour                Colour for all other than bar
  267.        3     BarColour                    Colour of the bar
  268.        4     Barchar          #                Char to use for bar
  269.        5     FirstStart       50 BUSY          Explained later
  270.        6     FirstStop        30 BUSY          Explained later
  271.        7     FirstDwn         -5 BUSY          Explained later
  272.        8     SecondStart      28 BUSY          Explained later
  273.        9     SecondStop       0  BUSY          Explained later
  274.       10     SecondDwn        -2 BUSY          Explained later
  275.  
  276.     Using the last six lines would create a chart listed from 50% to 30%
  277.     with 5 less in each entry followed by 28% to 0% with 2 less in each
  278.     entry. Thus would it look like this:
  279.     
  280.     50
  281.     45
  282.     40
  283.     35
  284.     30
  285.     28
  286.     26
  287.     24
  288.     22
  289.     20
  290.     
  291.     and so on... Get the picture? It decreases with 5 until it gets to 30
  292.     where it starts decreasing with 2 for better accuracy.
  293.  
  294.     The keyword BUSY must be entered after each value that relates to
  295.     the busychart. Just like you have to enter UPLOAD after the numbers
  296.     relating to the uploadchart, DOWNLOAD after numbers relating to
  297.     the downloadchart, BSYHOUR after numbers relating to the
  298.     busyhourchart and BSYWEEK after numbers relating to the
  299.     busyweekchart.
  300.     You MUST have the values for a chart in the config if you're
  301.     planning to create such a chart. Otherwise you're bound to get an
  302.     errormessage!
  303.     For more info about the configfile, please look at the sample config
  304.     that came with the programme!
  305.  
  306.  
  307. USAGE:
  308. ~~~~~~
  309. BusyTime [TOTAL] [BUSY] [UPLOAD] [DOWNLOAD] [BSYHOUR]
  310.          [BSYWEEK] [ALL] [NOSCAN] [SCREEN] [NOENV] [node#]
  311.  
  312. By default, BusyTime creates no stats at all anymore! It only updates
  313. the datafile for the node entered, or for node 1 if no node is entered.
  314. Therefor you'll have to enter what statscharts to create.
  315.  
  316. "BusyTime BUSY UPLOAD"    would create busystats and uploadstats.
  317. "BusyTime TOTAL DOWNLOAD" would create totalstats and downloadstats.
  318. "BusyTime BUSY 2"         would create busystats for node 2.
  319. "BusyTime ALL"            would create all charts for node 1.
  320. "BusyTime ALL NOSCAN"     would create all charts without scanning.
  321. ...and so on!
  322.  
  323. Remember to allways put the nodenumber (if any) LAST!
  324.  
  325. After the logfile for that node has been scanned, the last answeringline
  326. will be saved in a file called "BusyTimeX.Lastline", where X is the
  327. nodenumber, letting BusyTime know where to start looking for new entries
  328. the next time the programme is run.
  329.  
  330. A logfile will be created in Xconfig:Busytime/Data/ with info and stats for
  331. the last 75 days (or less). This data will be used in the future for creating
  332. the charts...
  333.  
  334. The keyword BSYHOUR creates a textfile with statistics about the
  335. hourly busyness of your BBS. The programme logges even how many days the
  336. statistics is for, and uses this to compute the average. It even checks
  337. what time of day it is when the chart is created, and for entries after
  338. current time of day, it will continue to use yesterdays data.
  339. On the current hour, it will check how much time of the hour that's gone
  340. by, and recalculate to get an exact value!
  341.  
  342. The keyword SCREEN lets you view the charts directly in a shell window while
  343. creating the charts.
  344.  
  345. You can create a file in ENV: called Busytime.env containing all the
  346. keywords you like except the node#. If you have created this file you
  347. don't have to enter these keywords at the commandline.If you don't want to
  348. use the keywords in ENV: you can enter NOENV as a keyword.
  349.  
  350.  
  351. REQUIREMENTS:
  352. ~~~~~~~~~~~~~
  353. 2MB free memory
  354. LIBS:hbasic2.library
  355. XConfig:BusyTime/BusyTime.cfg
  356. XConfig:BusyTime/TotalTemplate<n>
  357. XConfig:BusyTime/Data/
  358.  
  359.  
  360. FOUND A BUG?:
  361. ~~~~~~~~~~~~~
  362. If you by any chance should find a bug or any other nasty creatures, you
  363. can reach me at my BBS:
  364.  
  365.   Absolut BBS -  +46 44 247248.        Open 24h, every day of the week,
  366.                                        every week of the year!
  367.  
  368. You can also reach me at the following address:
  369.  
  370.                                 Ulf Nilsson
  371.                                 Fadriften 53
  372.                                 S-296 33 Ahus
  373.                                    SWEDEN
  374.  
  375. (Not that I think anybody will actually write, but anyway...)
  376.  
  377. Or you can use my FidoNet address: 2:200/621.0
  378. Or why not my E-mail address     : uni@absolut.ct.se
  379.  
  380.  
  381. THANKS:
  382. ~~~~~~~
  383. ...for the next version of Xenolink with hopefully a LOT of bugfixes! :)
  384.  
  385.  
  386. EPILOGUE:
  387. ~~~~~~~~~
  388. You can always find updates (if there are any) on my BBS as soon as they are
  389. finished. The number is listed above.
  390.  
  391. Until the next door/util, see ya all in Microcosmos!
  392.  
  393. Greetings..    __  __    _   __
  394.                //  //    /\  //
  395.              _//  //    //\\//
  396.               \\_//lf _//  \/ilsson  ..SysOp Absolut BBS!
  397.